cs-invoice-processing-sapi
📘 Documentación de la API - Servicio de Procesamiento de Facturas
Esta sección describe los atributos y uso del Servicio API de Procesamiento de Facturas.
💂️ Información Base
- Título de la API: Servicio API de Procesamiento de Facturas
- Versión: v1
- URL Base:
https://cs-invoice-processing-sapi-{env}-v1.us-e1.cloudhub.io/api/
Reemplaza {env} con:
dev(Desarrollo)qa(Aseguramiento de Calidad)prod(Producción)
🔑 Autenticación
Encabezados Requeridos
| Encabezado | Tipo | Descripción |
|---|---|---|
| Authorization | String | Token Bearer en el formato Bearer {{API_KEY}} |
| client_id | String | Identificador único para clientes API |
- Authorization
- Longitud: 36 - 37 caracteres
- Ejemplo:
Bearer abcdefghijklmnopqrstuvwxyz1234567890
- client_id
- Longitud: 32 - 36 caracteres
- Ejemplo:
123e4567-e89b-12d3-a456-426614174000
📌 Estos encabezados son requeridos en todas las solicitudes.
📂 Endpoints
📄 GET /documents/pending
Retorna los identificadores únicos de los documentos que están pendientes de envío al ERP.
Parámetros de Consulta
| Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
| customerTaxID | String | ✅ | ID fiscal de la empresa receptora |
| documentTypeCode | String | ❌ | Tipo de documento a recuperar |
Respuesta
Retorna una lista de identificadores de documentos.
📁 Ejemplo: examples/responses/get-pendingDocuments.json
📄 GET /documents/returnDocuments
Retorna la estructura de datos de una factura en formato XML.
Parámetros de Consulta
| Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
| customerTaxID | String | ❌ | ID de la empresa receptora |
| idInvoice | Number | ❌ | Identificador de la factura |
| filingNumber | String | ❌ | Número de radicación del documento |
Respuesta
Retorna la estructura completa de un documento.
📁 Ejemplo: examples/responses/get-documents.json
📄 GET /documents/attachments
Retorna los archivos proporcionados por el proveedor para procesar la factura.
Parámetros de Consulta
| Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
| customerTaxID | String | ❌ | ID de la empresa receptora |
| idInvoice | Number | ❌ | Identificador de la factura |
| filingNumber | String | ❌ | Número de radicación del documento |
Respuesta
📁 Ejemplo: examples/responses/get-attachments.json
📄 POST /documents/processed
Marca el documento como procesado por el ERP.
Cuerpo de la Solicitud
📁 Ejemplo: examples/requests/post-processed.json
📄 Tipo: lib-types.post-processed
Respuesta
📁 Ejemplo: examples/responses/post-processed.json
📄 Tipo: lib-types.post-processed-response
📄 POST /documents/status
Actualiza el estado de una factura después de la entrega al ERP.
Solicitud / Respuesta
📁 Solicitud: examples/requests/post-status.json
📁 Respuesta: examples/responses/post-status.json
📄 Tipo: lib-types.post-status
📄 POST /documents/suppliers
Crea proveedores en Invoway.
Solicitud / Respuesta
📁 Solicitud: examples/requests/post-suppliers.json
📁 Respuesta: examples/responses/post-suppliers.json
📄 Tipo: lib-types.post-suppliers
📄 POST /suppliers/externalUser
Crea un usuario para un proveedor usando autenticación externa.
Solicitud / Respuesta
📁 Solicitud: examples/requests/post-suppliers-externalUser.json
📁 Respuesta: examples/responses/post-suppliers-externalUser.json
📄 GET /digital-wallets/send-payments-orders
Envía órdenes de pago.
Parámetros de Consulta
| Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
| markToSend | Integer | ✅ | Indica documentos a ser enviados |
📁 Respuesta: examples/responses/get-send-payments-orders.json
📄 Tipo: lib-types.get-send-payments-orders-response
📄 POST /digital-wallets/receive-payments-orders
Recibe el resultado de órdenes de pago procesadas desde billeteras digitales.
📁 Solicitud: examples/requests/post-receive-payments-orders.json
📁 Respuesta: examples/responses/post-receive-payments-orders.json
📄 Tipo: lib-types.post-receive-payments-orders
📊 Parámetros Comunes
| Parámetro | Tipo | Descripción | Requerido |
|---|---|---|---|
client_id | String | Identificador de cliente API | ✅ |
Authorization | String | Token Bearer para autenticación | ✅ |
🔐 Esquemas de Seguridad
Aplicación de ID de Cliente
| Campo | Tipo | Requerido | Longitud | Regex |
|---|---|---|---|---|
client_id | String | Sí | 32 - 36 | [a-zA-Z0-9] |
client_secret | String | Sí | 32 - 64 | [a-zA-Z0-9] |
OAuth 2.0
| Campo | Tipo | Requerido | Longitud | Regex |
|---|---|---|---|---|
Authorization | String | Sí | 36 - 37 | [a-zA-Z0-9-_.] |
⚠️ Códigos de Error
| Código | Descripción | Solución Sugerida |
|---|---|---|
| 400 | Solicitud Incorrecta | Verificar sintaxis y parámetros de la solicitud. |
| 401 | No Autorizado | Validar credenciales de autenticación. |
| 404 | No Encontrado | Confirmar la URL del endpoint. |
| 500 | Error Interno del Servidor | Reintentar o contactar soporte técnico. |
📞 Soporte
Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.
Correo electrónico: epalma@fgs.co
📅 Información Adicional
- Documentación actualizada por última vez: Noviembre 2025
- Para actualizaciones adicionales, consulta el Portal de Exchange de API
Documentación actualizada en Noviembre 2025 por epalma@fgs.co - Edna Nayibe Palma
© 2025 Fundación Grupo Social - Colmena. Archivo generado para la API cs-utilities-system-api-services